<HTML>
<HEAD>
<TITLE>HELP - varCmd.page</TITLE>
<script type="text/javascript">
  var relPathToCommmon = "../../common/";
  var relPathToHelpDir = "../../common/help/";
</script>
<script type="text/javascript" src="../../common/jsdyn.js" language="JavaScript"></script>
<script type="text/javascript" src="../../common/js.js" language="JavaScript"></script>
<script type="text/javascript" src="leftmenu.js" language="JavaScript"></script>
<script type="text/javascript">
  var toSearchPage     = "_search','../../search";
  Body1();
</script>
<div class="headerPage">HELP - varCmd.page</div>
<div class="path"><a href="#" OnMouseOver="link('','../../index',this)" class="pathLink">Help</A><img src="../../common/path-arrow.gif" class="path-arrow"><a href="#" OnMouseOver="link('_dir','CommandReference0',this)" class="pathLink">Command Reference</A><img src="../../common/path-arrow.gif" class="path-arrow"><span class="pathNonLink">varCmd.page</span></div>
<script type="text/javascript">
 Body2();
 BodyLeftMenuStart();
WriteLeftMenu("","","","");
 BodyLeftMenuEnd();
 Body3();
</script>
<span class="tabInActive"><a href="#" OnMouseOver="linkTab('_file','varCmd_page0','_description',this)" class="tabLinkInActive">Description</a></span>
<span class="tabInActiveGrayout"><span class="tabLinkGrayout">Overview</span></span>
<span class="tabInActiveGrayout"><span class="tabLinkGrayout">Included files</span></span>
<span class="tabInActiveGrayout"><span class="tabLinkGrayout">Included by</span></span>
<span class="tabActive"><a href="#" OnMouseOver="linkTab('_file','varCmd_page0','_source',this)" class="tabLinkActive">Source</a></span>
<script type="text/javascript">
 Body4();
</script>
<div class="contentAirTop"></div>
<pre class="codeExamples">
/**
\page varCmd
!!! Attaching comment block to a specific variable / enum / define ( var )
The var command is used to explicitly link a documentation comment block to the 
specified variable / enum or define. When documenting variables it's necessary to 
specify the type of the variable also. The $\\var$ command is also used when 
documenting enum values in a separate file, see SepDocClass::ClassEnum SepDocClass::eClassEnumVal1 
for an example. Also it's important to qualify the name with full scope.

!Syntax
\code
/**
\var <type> [scope]<var_name>
Normal way of documenting goes here ....
\endds_doc \endcode

!Example
\code
/**
\var int SepDocClass::ClassUnion::m_iClassUnionIntMember
Normal way of documenting goes here ....
\endds_doc \endcode

!Output
The var command does not produce any output of its own, but secures that the 
comment block as a whole is used to produce the documentation of the specified 
class. But see SepDocClass::ClassUnion::m_iClassUnionIntMember.
\include separate_docs.inc
*/
</pre><div class="contentAirBottom"></div>
<script type="text/javascript">
 Body5();
Statistics("","","","","");
 Body6();
SetPageTab('_file','_source');
</script>
